package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.TaskAddDTO;
import org.jsola.hr.dto.TaskUpdateDTO;
import org.jsola.hr.query.TaskQuery;
import org.jsola.hr.vo.TaskListVO;
import org.jsola.hr.vo.TaskVO;

import java.util.List;

/**
 * 人力定时任务
 *
 * @author zhr
 */
@Api(tags = "hr-人力定时任务")
public interface ITaskControllerAPI {

    /**
     * 新增人力定时任务
     * @param taskAddDTO 人力定时任务新增实体
     * @return 人力定时任务展示对象
     */
    @ApiOperation(value = "新增人力定时任务")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "taskAddDTO", dataType = "TaskAddDTO", value = "新增人力定时任务", paramType = "body")
    })
    Result<TaskVO> save(TaskAddDTO taskAddDTO);


    /**
     * 修改人力定时任务
     * @param taskUpdateDTO 人力定时任务
     * @return 更新数量
     */
    @ApiOperation(value = "修改人力定时任务")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "taskUpdateDTO", dataType = "TaskUpdateDTO", value = "修改人力定时任务", paramType = "body")
    })
    Result<Integer> update(TaskUpdateDTO taskUpdateDTO);




    /**
     * 删除单个人力定时任务，彻底删除
     * @param taskId 人力定时任务id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个人力定时任务，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "taskId", dataType = "String", value = "人力定时任务id", paramType = "path")
    })
    Result<Integer> delete(String taskId);


    /**
     * 批量删除人力定时任务，彻底删除
     * @param taskIds 人力定时任务id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除人力定时任务，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "taskIds", dataType = "String[]", value = "人力定时任务id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] taskIds);


    /**
     * 根据人力定时任务id查询人力定时任务详情
     * @param taskId 人力定时任务id
     * @return 人力定时任务详情
     */
    @ApiOperation(value="根据人力定时任务id查询人力定时任务详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "taskId", dataType = "String", value = "人力定时任务id", paramType = "path")
    })
    Result<TaskVO> findById(String taskId);


    /**
     * 查询人力定时任务
     * @param taskQuery 人力定时任务查询参数
     * @return page
     */
    @ApiOperation(value="查询人力定时任务")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "taskQuery", dataType = "TaskQuery", value = "人力定时任务查询参数", paramType = "query")
    })
    Result<List<TaskListVO>> listAll(TaskQuery taskQuery);


     /**
     * 分页查询人力定时任务
     * @param taskQuery 人力定时任务查询参数
     * @return page
     */
    @ApiOperation(value="分页查询人力定时任务")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "taskQuery", dataType = "TaskQuery", value = "人力定时任务查询参数", paramType = "query")
    })
    Result<Page<TaskListVO>> page(TaskQuery taskQuery);


}

